/*
 * Created by SharpDevelop.
 * User: David
 * Date: 2006-12-04
 * Time: 03:28
 * 
 * To change this template use Tools | Options | Coding | Edit Standard Headers.
 */

using System;

namespace tools
{
	/// <summary>
	/// This class holods results from different operations conducted within this assembly.
	/// It can only be instanciated from within the assembly, due to the protection level of
	/// the ctor.
	/// </summary>
	public class ToolsResult
	{
		#region members
		
		/// <summary>
		/// The header of the result
		/// </summary>
		internal string		m_Header;
		/// <summary>
		/// The message of the result
		/// </summary>
		internal string		m_Result;
		/// <summary>
		/// The status of the result. True if it failed, otherwise false
		/// </summary>
		internal bool		m_Failed;
		
		#endregion
		
		#region constructors
		
		/// <summary>
		/// Constructor, initializes members.
		/// </summary>
		internal ToolsResult()
		{
			m_Header = "";
			m_Result = "";
			m_Failed = false;
		}
		
		#endregion
		
		#region properties
		
		/// <summary>
		/// The header of the error report, kind of like a title (get)
		/// </summary>
		public string Header
		{
			get
			{
				return m_Header;
			}
		}
		
		/// <summary>
		/// The message of the error, i.e. the report in itself (get)
		/// </summary>
		public string Result
		{
			get
			{
				return m_Result;
			}
		}
		
		/// <summary>
		/// If this is true, something has failed. Check header and report to see what (get)
		/// </summary>
		public bool Failed
		{
			get
			{
				return m_Failed;
			}
		}
		
		#endregion
	}
}
